home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / system / puff307.zip / PUFF.DOC < prev    next >
Text File  |  1989-05-18  |  51KB  |  1,365 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.                           PUFF Version 3.07
  24.                         A Pop-Up File Facility
  25.  
  26.                              April 1989
  27.  
  28.                            David Mitchell
  29.  
  30.  
  31.  
  32.  
  33. INTRODUCTION
  34.  
  35. PUFF is a  directory and file browser which  pops up on demand. It takes
  36. up between 29 and 42K of memory when resident (depending on installation
  37. options). It runs under DOS 2 or 3 on any model PC and will work on both
  38. Mono and  Color  adapters.  Once installed  you pop it up at any time by
  39. pressing the  hot-key  which by  default  is Alt-D.  This  gives you the
  40. ability to browse directories and both ASCII and non-ASCII files  within
  41. other   programs  such  as  word   processors,  spread-sheets, debuggers
  42. or even at the  DOS prompt.  It's intended to be very  easy  to use  and
  43. contains several screens of on-line help via the F1 key so you shouldn't
  44. need to read this document to use it!
  45.  
  46. PUFF makes it possible to do things like:
  47.  
  48. o   browse the source of a program while debugging it
  49.  
  50. o   check the name  of a file  in a directory before loading  it into  a
  51.     spread-sheet
  52.  
  53. o   quickly move up and down a directory tree looking for a file
  54.  
  55. o   check when you last saved a particular file
  56.  
  57. o   copy part or all of one file into an editor or word processor
  58.  
  59. o   see how much room there is on a diskette before saving a file on it
  60.  
  61. o    erase, copy or rename files at any time
  62.  
  63. o   and lots more!
  64.  
  65. There are three reasons why PUFF may not be able to pop up when you want
  66. it to:
  67.  
  68. 1.  the  application  that's  currently  running  is  not  asking for  a
  69.     keystroke. PUFF  won't pop up  in long-running "batch" programs like
  70.     compiles or assemblies.
  71.  
  72. 2.  the current display is in a  graphics mode. PUFF  can only pop up in
  73.     text modes.
  74.  
  75. 3.  at the time you ask PUFF to pop up, DOS is busy. PUFF checks to make
  76.     sure that nothing dangerous (such as file I/O)  is going on when you
  77.     ask it to pop up.
  78.  
  79. Despite all my efforts, PUFF is still  not entirely crash-proof. See the
  80. section on "Things to Avoid" for more details.
  81.  
  82.  
  83.  
  84.  
  85. SUMMARY OF CHANGES
  86.  
  87. PUFF  Version 3 is a major rewrite of PUFF.  Many new features have been
  88. added and a few have been dropped.  Here's a summary:
  89.  
  90.  
  91. General Changes:
  92.  
  93. o   support for larger screens (43-line etc)
  94.  
  95. o   some support for enhanced keyboard (although PUFF doesn't know names
  96.     such as F11, F12 etc, they can be set as the hot-key)
  97.  
  98. o   better bw80 support (treated as Mono not Color)
  99.  
  100. o   all PUFFSET customizing functions now included
  101.  
  102. o   the directory/file buffer is now 6 or 12K
  103.  
  104. o   the PUFF box can  be quickly moved to screen corners using Home, End
  105.     PgUp and PgDn keys
  106.  
  107. o   when pasting, line feeds can be ignored or pasted
  108.  
  109. o   the normal cursor is suppressed when PUFF is popped up
  110.  
  111. o   PUFF now always pops up on  the current DOS screen (can't force Mono
  112.     anymore)
  113.  
  114. o   PUFF no longer supports 40-column screens
  115.  
  116. o   it's got bigger!
  117.  
  118.  
  119. In Directory Browse:
  120.  
  121. o   new popup menu of commands via "?"
  122.  
  123. o   attributes can be shown (instead of size)
  124.  
  125. o   date/time are properly country-dependent
  126.  
  127. o   sorting is almost twice as fast
  128.  
  129. o   original DOS order can be restored
  130.  
  131. o   new commands  allow copy, erase  and rename of files  (and rename of
  132.     directories and moving of files)
  133.  
  134. o   can now switch directly to another directory via 'N' command
  135.  
  136. o   customize options menus available directly via 'O' command
  137.  
  138. o   can now make and remove subdirectories
  139.  
  140.  
  141.  
  142.  
  143.  
  144. o   can now directly invoke and editor of your choice, provided PUFF was
  145.     popped up from the command line (new I command)
  146.  
  147. o   can now set current DOS drive and directory  to  the  same as PUFF's
  148.     (new K command)
  149.  
  150. A number of commands have had to change "name":
  151.  
  152.     D  does Directory Refresh (was R for Refresh) since R is Rename
  153.     T  forces TEXT mode file browse (was A for ASCII) since A now
  154.        toggles Attribute/size display
  155.  
  156.  
  157. In File Browse:
  158.  
  159. o   new popup menu of commands via "?"
  160.  
  161. o   can now switch directly to another file via 'N' command
  162.  
  163. o   customise options menus available directly via 'O' command
  164.  
  165. o   browsing is almost twice as fast
  166.  
  167. o   searching is almost twice as fast
  168.  
  169. o   search string can always be entered in hex or text
  170.  
  171. o   search can be case sensitive or not as required
  172.  
  173. o   in text mode, the cursor moves as in a normal editor
  174.  
  175. o   can now safely browse past column 255
  176.  
  177. A number of commands have had to change "name":
  178.  
  179.     T  goes from HEX to Text mode (used to be A for ASCII)
  180.     A  switches to ASCII rather than EBCDIC when in HEX mode (was
  181.        T for Translate) since T goes to Text mode
  182.     R  does repeat search (was N for Next) since N goes to New file
  183.  
  184.  
  185. INSTALLING PUFF
  186.  
  187. When  invoked,  PUFF  looks  for  its profile  in the  current and  root
  188. directories of the  current  drive. The profile, a file called PUFF.PRO,
  189. can  be  created  or   tailored  using  PUFF  itself  (see  the  section
  190. "Customizing PUFF"). Use SUBST, EXT, SRCHDIR or a similar program if you
  191. want to put it  somewhere else. If PUFF  can't find  its profile it uses
  192. default values.
  193.  
  194. The PUFF command looks like this:
  195.  
  196.           PUFF [hotkey] [initvu] [/n][/e][/s][/b][/l][/q][/x][/h]
  197.      or
  198.           PUFF ?
  199.  
  200.  
  201.  
  202.  
  203. The second form will give you a brief description of PUFF and the syntax
  204. of the first form.
  205.  
  206. All  the parameters in the first form of  the command  are optional. The
  207. first, the hot-key, is Alt-D by default but PUFF will accept:
  208.  
  209.      a-x        where x is any letter a-z   (26 Alt keys)
  210.      c-x        where x is any letter a-z   (26 Ctrl-keys)
  211.      fn         where n is any number 1-10  (10 Function keys)
  212.      a-fn       where n is any number 1-10  (10 Alt-Function keys)
  213.      c-fn       where n is any number 1-10  (10 Ctrl-Function keys)
  214.      s-fn       where n is any number 1-10  (10 Shift-Function keys)
  215.  
  216. The default hot-key can  be changed by creating a new  PUFF profile. See
  217. the section "Customizing PUFF" for details. Function keys F1 and F2 have
  218. special uses inside PUFF so they should not be used as hot-keys.
  219.  
  220. The second parameter, initvu, lets you specify the name of a file  which
  221. PUFF will display on  first popping up (rather than displaying the  main
  222. menu). Note  PUFF will treat anything it doesn't recognise  as a hot-key
  223. as an initvu specification. If your initvu option could be mistaken for
  224. a hot key (e.g. "F2") then you must specify the hot-key too. If the name
  225. matches a set of files  (e.g. it  contains  an asterisk), then PUFF will
  226. popup in directory browse.
  227.  
  228. The /r option lets you remove a  copy of  PUFF that is already resident.
  229. This  can  be useful in BAT files that invoke programs incompatible with
  230. PUFF, as a way of ensuring that PUFF is not present.
  231.  
  232. If you  attempt to install PUFF when  it already  resident PUFF will not
  233. re-install itself  but will  tell you  what  the hot-key of the  already
  234. installed version is.
  235.  
  236. The /n (Normal) option restricts PUFF to the top 25 lines of the screen.
  237. This reduces memory requirements by about 4K.
  238.  
  239. The /e (EGA) option allows PUFF to use up to 50 screen lines (on an EGA,
  240. VGA or MCGA), but increases memory requirements by about 4K.
  241.  
  242. The /s  (Small)  option  forces  PUFF to  use only  6K  of buffer space,
  243. reducing its memory requirements at the cost of performance.
  244.  
  245. The  /b (Big) option makes PUFF use 12K of buffer space, by doubling the
  246. sizes of PUFF's directory and file  buffers. This allows PUFF  to handle
  247. directories with up to  555 files. If there are less than 275 files then
  248. PUFF  does not have to re-read  the directory when returning from a file
  249. browse, improving performance considerably. The  extra file buffer makes
  250. scrolling through a file faster too, since the file is read in 4k rather
  251. than 2k chunks.
  252.  
  253. The /l  (Loud)  option  makes  PUFF  install itself noisily, producing a
  254. banner which gives its version number and buffer sizes
  255.  
  256. The /q (Quiet)  option  makes PUFF  install itself quietly,  without any
  257. banner or messages.
  258.  
  259.  
  260.  
  261.  
  262.  
  263. The /x  (eX